curl --request GET \
--url https://api.loops.fi/api/v3/payment-links \
--header 'Authorization: Bearer <token>'{
"object": "list",
"data": [
{
"id": "<string>",
"object": "payment_link",
"active": true,
"after_completion": {
"hosted_confirmation": {
"custom_message": "<string>"
},
"redirect": {
"url": "<string>"
},
"type": "hosted_confirmation"
},
"allow_promotion_codes": true,
"application_fee_amount": 123,
"application_fee_percent": 123,
"automatic_tax": {
"enabled": true
},
"billing_address_collection": "auto",
"consent_collection": {
"promotions": "auto",
"terms_of_service": "none"
},
"currency": "<string>",
"custom_fields": [
{
"key": "<string>",
"label": {
"custom": "<string>",
"type": "custom"
},
"optional": true,
"type": "dropdown"
}
],
"custom_text": {
"after_submit": {
"message": "<string>"
},
"shipping_address": {
"message": "<string>"
},
"submit": {
"message": "<string>"
},
"terms_of_service_acceptance": {
"message": "<string>"
}
},
"customer_creation": "always",
"line_items": {
"data": [
{
"id": "<string>",
"object": "item",
"price": {
"id": "<string>",
"object": "price",
"active": true,
"billing_scheme": "per_unit",
"created": 123,
"currency": "<string>",
"custom_unit_amount": {
"maximum": 123,
"minimum": 123,
"preset": 123
},
"livemode": true,
"lookup_key": "<string>",
"metadata": {},
"nickname": "<string>",
"product": "<string>",
"recurring": {
"aggregate_usage": "last_during_period",
"interval": "day",
"interval_count": 123,
"trial_period_days": 123,
"usage_type": "licensed"
},
"tax_behavior": "exclusive",
"tiers_mode": "graduated",
"transform_quantity": {
"divide_by": 123,
"round": "down"
},
"type": "one_time",
"unit_amount": 123,
"unit_amount_decimal": "<string>"
},
"quantity": 123
}
],
"has_more": true,
"object": "list",
"total_count": 123,
"url": "<string>"
},
"livemode": true,
"metadata": {},
"on_behalf_of": "<string>",
"payment_method_collection": "always",
"payment_method_types": [
"<string>"
],
"phone_number_collection": {
"enabled": true
},
"shipping_address_collection": {
"allowed_countries": [
"<string>"
]
},
"submit_type": "auto",
"subscription_data": {
"description": "<string>",
"trial_period_days": 123
},
"tax_id_collection": {
"enabled": true
},
"transfer_data": {
"amount": 123,
"amount_percent": 123,
"destination": "<string>"
},
"url": "<string>",
"label": "<string>",
"products": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"price": 123,
"currency": "<string>",
"type": "recurring",
"status": "<string>",
"quantity": 123,
"displayOrder": 123
}
],
"successUrl": "<string>",
"cancelUrl": "<string>",
"allowDiscountCodes": true,
"collectBilling": true,
"views": 123,
"conversions": 123,
"revenue": 123,
"status": "active",
"merchant": {
"id": "<string>",
"companyName": "<string>",
"logo": "<string>"
}
}
],
"has_more": true,
"url": "<string>"
}List payment links (Stripe-compatible)
curl --request GET \
--url https://api.loops.fi/api/v3/payment-links \
--header 'Authorization: Bearer <token>'{
"object": "list",
"data": [
{
"id": "<string>",
"object": "payment_link",
"active": true,
"after_completion": {
"hosted_confirmation": {
"custom_message": "<string>"
},
"redirect": {
"url": "<string>"
},
"type": "hosted_confirmation"
},
"allow_promotion_codes": true,
"application_fee_amount": 123,
"application_fee_percent": 123,
"automatic_tax": {
"enabled": true
},
"billing_address_collection": "auto",
"consent_collection": {
"promotions": "auto",
"terms_of_service": "none"
},
"currency": "<string>",
"custom_fields": [
{
"key": "<string>",
"label": {
"custom": "<string>",
"type": "custom"
},
"optional": true,
"type": "dropdown"
}
],
"custom_text": {
"after_submit": {
"message": "<string>"
},
"shipping_address": {
"message": "<string>"
},
"submit": {
"message": "<string>"
},
"terms_of_service_acceptance": {
"message": "<string>"
}
},
"customer_creation": "always",
"line_items": {
"data": [
{
"id": "<string>",
"object": "item",
"price": {
"id": "<string>",
"object": "price",
"active": true,
"billing_scheme": "per_unit",
"created": 123,
"currency": "<string>",
"custom_unit_amount": {
"maximum": 123,
"minimum": 123,
"preset": 123
},
"livemode": true,
"lookup_key": "<string>",
"metadata": {},
"nickname": "<string>",
"product": "<string>",
"recurring": {
"aggregate_usage": "last_during_period",
"interval": "day",
"interval_count": 123,
"trial_period_days": 123,
"usage_type": "licensed"
},
"tax_behavior": "exclusive",
"tiers_mode": "graduated",
"transform_quantity": {
"divide_by": 123,
"round": "down"
},
"type": "one_time",
"unit_amount": 123,
"unit_amount_decimal": "<string>"
},
"quantity": 123
}
],
"has_more": true,
"object": "list",
"total_count": 123,
"url": "<string>"
},
"livemode": true,
"metadata": {},
"on_behalf_of": "<string>",
"payment_method_collection": "always",
"payment_method_types": [
"<string>"
],
"phone_number_collection": {
"enabled": true
},
"shipping_address_collection": {
"allowed_countries": [
"<string>"
]
},
"submit_type": "auto",
"subscription_data": {
"description": "<string>",
"trial_period_days": 123
},
"tax_id_collection": {
"enabled": true
},
"transfer_data": {
"amount": 123,
"amount_percent": 123,
"destination": "<string>"
},
"url": "<string>",
"label": "<string>",
"products": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"price": 123,
"currency": "<string>",
"type": "recurring",
"status": "<string>",
"quantity": 123,
"displayOrder": 123
}
],
"successUrl": "<string>",
"cancelUrl": "<string>",
"allowDiscountCodes": true,
"collectBilling": true,
"views": 123,
"conversions": 123,
"revenue": 123,
"status": "active",
"merchant": {
"id": "<string>",
"companyName": "<string>",
"logo": "<string>"
}
}
],
"has_more": true,
"url": "<string>"
}API Key authentication using Bearer token
Filter by status
ACTIVE, INACTIVE, DRAFT Filter by pricing type
FREE, ONE_TIME, RECURRING Number of payment links to return (1-100)
Offset for pagination
Default Response
String representing the object's type
list An array of objects
Show child attributes
Unique identifier for the object
String representing the object's type
payment_link Whether the payment link's url is active
Show child attributes
hosted_confirmation, redirect Whether the payment link's url is active
The amount of the application fee
The percentage of the application fee
auto, required Three-letter ISO currency code
Show child attributes
dropdown, numeric, text Show child attributes
always, if_required Show child attributes
Show child attributes
item Show child attributes
price per_unit, tiered Show child attributes
last_during_period, last_ever, max, sum day, month, week, year licensed, metered exclusive, inclusive, unspecified graduated, volume one_time, recurring list Has the value true if the object exists in live mode or the value false if the object exists in test mode
Set of key-value pairs that you can attach to an object
always, if_required The list of payment method types that customers can use
auto, book, donate, pay The URL to the payment link
Payment link label (Loops-specific)
Show child attributes
Success redirect URL (Loops-specific)
Cancel redirect URL (Loops-specific)
active, expired, disabled Whether there are more objects available after this set
The URL to access this list